Skip to content

[DBA-282] Replace generic coding guidelines with Python-specific doc#67

Merged
gasparian merged 4 commits intomainfrom
andrei.gasparian/DBA-282-python-coding-guidelines
Mar 20, 2026
Merged

[DBA-282] Replace generic coding guidelines with Python-specific doc#67
gasparian merged 4 commits intomainfrom
andrei.gasparian/DBA-282-python-coding-guidelines

Conversation

@gasparian
Copy link
Contributor

Summary

Replace the generic docs/coding-guidelines.md with docs/python-coding-guidelines.md — project-specific Python patterns with code examples, stripped of filler. Filename scoped to Python for future TypeScript guidelines.

Changes

New Python coding guidelines

  • Databao-cli-specific patterns: CLI layer (Click), error handling, data modelling, MCP tools, concurrency, logging
  • Code examples pulled from actual codebase
  • Explicit "things to avoid" section
Files
  • docs/python-coding-guidelines.md (new)
  • docs/coding-guidelines.md (deleted)

Reference updates

  • Updated all references to the renamed file
Files
  • CLAUDE.md
  • .pre-commit-config.yaml
  • scripts/smoke-test-skills.sh
  • .claude/skills/review-architecture/SKILL.md

Test Plan

  • make check passes (ruff + mypy + validate-agent-guidance)
  • make test passes (65/65)
  • make lint-skills passes
  • make smoke-skills — all review-architecture doc checks pass

🤖 Generated with Claude Code

Strip filler advice from docs/coding-guidelines.md and rewrite as
docs/python-coding-guidelines.md — grounded in actual databao-cli
patterns with code examples. Filename scoped to Python so future
TypeScript guidelines slot in cleanly. Update all references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Replaces the repo’s generic coding guidelines document with a Python-specific guidelines doc for databao-cli, and updates all internal references and validation hooks to point at the new filename.

Changes:

  • Added docs/python-coding-guidelines.md and removed docs/coding-guidelines.md.
  • Updated references in agent guidance docs and repo metadata files to the new doc path.
  • Updated smoke-test and pre-commit file filters to validate the new guidelines doc.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
scripts/smoke-test-skills.sh Updates smoke check to assert the new guidelines doc exists.
docs/python-coding-guidelines.md Introduces new Python-specific project coding guidelines and examples.
docs/coding-guidelines.md Deletes the old generic coding guidelines doc.
CLAUDE.md Updates reference link to point at the new guidelines doc.
.pre-commit-config.yaml Updates validate-agent-guidance hook file regex to include the new doc name.
.claude/skills/review-architecture/SKILL.md Updates the “review order” list to reference the new guidelines doc.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Andrei Gasparian and others added 2 commits March 20, 2026 11:43
…ei.gasparian/DBA-282-python-coding-guidelines
…ests

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gasparian gasparian requested a review from SimonKaran13 March 20, 2026 10:49
@gasparian gasparian merged commit 6e66254 into main Mar 20, 2026
6 checks passed
@gasparian gasparian deleted the andrei.gasparian/DBA-282-python-coding-guidelines branch March 20, 2026 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants